Vcenter NamespaceManagement VirtualMachineClasses CreateSpec

Vcenter NamespaceManagement VirtualMachineClasses CreateSpec
Vcenter NamespaceManagement VirtualMachineClasses CreateSpec

The Vcenter NamespaceManagement VirtualMachineClasses CreateSpec schema contains the specification required to create a VM class object.

This schema was added in vSphere API 7.0.2.00100.

JSON Example
{
    "id": "string",
    "cpu_count": 0,
    "cpu_reservation": 0,
    "memory_mb": 0,
    "memory_reservation": 0,
    "description": "string",
    "devices": {
        "vgpu_devices": [
            {
                "profile_name": "string"
            }
        ],
        "dynamic_direct_path_io_devices": [
            {
                "vendor_id": 0,
                "device_id": 0,
                "custom_label": "string"
            }
        ]
    },
    "instance_storage": {
        "policy": "string",
        "volumes": [
            {
                "size": 0
            }
        ]
    },
    "config_spec": {}
}
string
id
Required

Identifier of the virtual machine class. This has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string and with maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. This name is unique in this vCenter server.

This property was added in vSphere API 7.0.2.00100.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

integer As int64 As int64
cpu_count
Required

The number of CPUs configured for virtual machine of this class.

This property was added in vSphere API 7.0.2.00100.

integer As int64 As int64
cpu_reservation
Optional

This property is deprecated as of vSphere API 8.0.2.0. Use CPU allocation in Vcenter NamespaceManagement VirtualMachineClasses CreateSpec.config_spec instead to reserve CPUs for a virtual machine.

The percentage of total available CPUs reserved for a virtual machine. We multiply this percentage by the minimum frequency amongst all the cluster nodes to get the CPU reservation that is specified to vSphere in MHz.

This property was added in vSphere API 7.0.2.00100.

If missing or null, no CPU reservation is requested for the virtual machine.

integer As int64 As int64
memory_mb
Required

The amount of memory in MB configured for virtual machine of this class.

This property was added in vSphere API 7.0.2.00100.

integer As int64 As int64
memory_reservation
Optional

This property is deprecated as of vSphere API 8.0.2.0. Use memory allocation in Vcenter NamespaceManagement VirtualMachineClasses CreateSpec.config_spec instead to reserve memory for a virtual machine.

The percentage of available memory reserved for a virtual machine of this class. Memory reservation must be set to 100% for VM class with vGPU or Dynamic DirectPath I/O devices.

This property was added in vSphere API 7.0.2.00100.

If missing or null, no memory reservation is requested for virtual machine.

string
description
Optional

Description for the VM class.

This property was added in vSphere API 7.0.2.00100.

If missing or null, no description is added to the VM class.

devices
Optional

This property is deprecated as of vSphere API 8.0.2.0. Use device changes in Vcenter NamespaceManagement VirtualMachineClasses CreateSpec.config_spec instead to add vGPU and Dynamic DirectPath I/O virtual devices.

Virtual devices that will be attached to the VMs created with this class.

This property was added in vSphere API 7.0.3.0.

If missing or null, no Virtual device will be attached to the VMs created with this class.

instance_storage
Optional

Instance storage that will be attached to the VMs created with this class.

This property was added in vSphere API 8.0.0.0.

If missing or null, instance storage specification will not be created.

object
config_spec
Optional

A VirtualMachineConfigSpec associated with the VM class.

This property was added in vSphere API 8.0.2.0.

If missing or null, no config spec will be associated to the VM Class.